<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
        "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
	<head>
		<meta http-equiv="content-type" content="text/html; charset=utf-8" />
		<meta name="generator" content="JsDoc Toolkit" />
		
		<title>JsDoc Reference - api.File</title>

		<style type="text/css">
			/* default.css */
body
{
	font: 12px "Lucida Grande", Tahoma, Arial, Helvetica, sans-serif;
	width: 800px;
}

.header
{
	clear: both;
	background-color: #ccc;
	padding: 8px;
}

h1
{
	font-size: 150%;
	font-weight: bold;
	padding: 0;
	margin: 1em 0 0 .3em;
}

hr
{
	border: none 0;
	border-top: 1px solid #7F8FB1;
	height: 1px;
}

pre.code
{
	display: block;
	padding: 8px;
	border: 1px dashed #ccc;
}

#index
{
	margin-top: 24px;
	float: left;
	width: 160px;
	position: absolute;
	left: 8px;
	background-color: #F3F3F3;
	padding: 8px;
}

#content
{
	margin-left: 190px;
	width: 600px;
}

.classList
{
	list-style-type: none;
	padding: 0;
	margin: 0 0 0 8px;
	font-family: arial, sans-serif;
	font-size: 1em;
	overflow: auto;
}

.classList li
{
	padding: 0;
	margin: 0 0 8px 0;
}

.summaryTable { width: 100%; }

h1.classTitle
{
	font-size:170%;
	line-height:130%;
}

h2 { font-size: 110%; }
caption, div.sectionTitle
{
	background-color: #7F8FB1;
	color: #fff;
	font-size:130%;
	text-align: left;
	padding: 2px 6px 2px 6px;
	border: 1px #7F8FB1 solid;
}

div.sectionTitle { margin-bottom: 8px; }
.summaryTable thead { display: none; }

.summaryTable td
{
	vertical-align: top;
	padding: 4px;
	border-bottom: 1px #7F8FB1 solid;
	border-right: 1px #7F8FB1 solid;
}

/*col#summaryAttributes {}*/
.summaryTable td.attributes
{
	border-left: 1px #7F8FB1 solid;
	width: 140px;
	text-align: right;
}

td.attributes, .fixedFont
{
	line-height: 15px;
	color: #002EBE;
	font-family: "Courier New",Courier,monospace;
	font-size: 13px;
}

.summaryTable td.nameDescription
{
	text-align: left;
	font-size: 13px;
	line-height: 15px;
}

.summaryTable td.nameDescription, .description
{
	line-height: 15px;
	padding: 4px;
	padding-left: 4px;
}

.summaryTable { margin-bottom: 8px; }

ul.inheritsList
{
	list-style: square;
	margin-left: 20px;
	padding-left: 0;
}

.detailList {
	margin-left: 20px; 
	line-height: 15px;
}
.detailList dt { margin-left: 20px; }

.detailList .heading
{
	font-weight: bold;
	padding-bottom: 6px;
	margin-left: 0;
}

.light, td.attributes, .light a:link, .light a:visited
{
	color: #777;
	font-style: italic;
}

.fineprint
{
	text-align: right;
	font-size: 10px;
}
		</style>
	</head>

	<body>
<!-- ============================== header ================================= -->	
		<!-- begin static/header.html -->
		<div id="header">
</div>
		<!-- end static/header.html -->

<!-- ============================== classes index ============================ -->
		<div id="index">
			<!-- begin publish.classesIndex -->
			<div align="center"><a href="../index.html">Class Index</a>
| <a href="../files.html">File Index</a></div>
<hr />
<h2>Classes</h2>
<ul class="classList">
	
	<li><i><a href="../symbols/_global_.html">_global_</a></i></li>
	
	<li><a href="../symbols/api.Access.html">api.Access</a></li>
	
	<li><a href="../symbols/api.Basic.html">api.Basic</a></li>
	
	<li><a href="../symbols/api.Channel.html">api.Channel</a></li>
	
	<li><a href="../symbols/api.Connection.html">api.Connection</a></li>
	
	<li><a href="../symbols/api.Dtx.html">api.Dtx</a></li>
	
	<li><a href="../symbols/api.Exchange.html">api.Exchange</a></li>
	
	<li><a href="../symbols/api.File.html">api.File</a></li>
	
	<li><a href="../symbols/api.Queue.html">api.Queue</a></li>
	
	<li><a href="../symbols/api.Stream.html">api.Stream</a></li>
	
	<li><a href="../symbols/api.Tunnel.html">api.Tunnel</a></li>
	
	<li><a href="../symbols/api.Tx.html">api.Tx</a></li>
	
	<li><a href="../symbols/handlers.html">handlers</a></li>
	
	<li><a href="../symbols/impl.html">impl</a></li>
	
</ul>
<hr />
			<!-- end publish.classesIndex -->
		</div>
		
		<div id="content">
<!-- ============================== class title ============================ -->
			<h1 class="classTitle">
				
				Class api.File
			</h1>

<!-- ============================== class summary ========================== -->			
			<p class="description">
				
				
			
				
				
				
					<br /><i>Defined in: </i> <a href="../symbols/src/src_api_file.js.html">file.js</a>.
				
			</p>

<!-- ============================== constructor summary ==================== -->			
			
			<table class="summaryTable" cellspacing="0" summary="A summary of the constructor documented in the class api.File.">
				<caption>Class Summary</caption>
				<thead>
					<tr>
						<th scope="col">Constructor Attributes</th>
						<th scope="col">Constructor Name and Description</th>
					</tr>
				</thead>
				<tbody>
					<tr>
						<td class="attributes">&nbsp;</td>
						<td class="nameDescription" >
							<div class="fixedFont">
								<b><a href="../symbols/api.File.html#constructor">api.File</a></b>()
							</div>
							<div class="description">Work with file content.</div>
						</td>
					</tr>
				</tbody>
			</table>
			

<!-- ============================== properties summary ===================== -->
			
				
				
				<table class="summaryTable" cellspacing="0" summary="A summary of the fields documented in the class api.File.">
					<caption>Field Summary</caption>
					<thead>
						<tr>
							<th scope="col">Field Attributes</th>
							<th scope="col">Field Name and Description</th>
						</tr>
					</thead>
					<tbody>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont">
								<b><a href="../symbols/api.File.html#clusterId">clusterId</a></b>
								</div>
								<div class="description">Intra-cluster routing identifier</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont">
								<b><a href="../symbols/api.File.html#contentEncoding">contentEncoding</a></b>
								</div>
								<div class="description">MIME content encoding</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont">
								<b><a href="../symbols/api.File.html#contentType">contentType</a></b>
								</div>
								<div class="description">MIME content type</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont">
								<b><a href="../symbols/api.File.html#filename">filename</a></b>
								</div>
								<div class="description">The message filename</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont">
								<b><a href="../symbols/api.File.html#headers">headers</a></b>
								</div>
								<div class="description">Message header field table</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont">
								<b><a href="../symbols/api.File.html#messageId">messageId</a></b>
								</div>
								<div class="description">The application message identifier</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont">
								<b><a href="../symbols/api.File.html#priority">priority</a></b>
								</div>
								<div class="description">The message priority, 0 to 9</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont">
								<b><a href="../symbols/api.File.html#replyTo">replyTo</a></b>
								</div>
								<div class="description">The destination to reply to</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont">
								<b><a href="../symbols/api.File.html#timestamp">timestamp</a></b>
								</div>
								<div class="description">The message timestamp</div>
							</td>
						</tr>
					
					</tbody>
				</table>
				
				
				
			

<!-- ============================== methods summary ======================== -->
			
				
				
				<table class="summaryTable" cellspacing="0" summary="A summary of the methods documented in the class api.File.">
					<caption>Method Summary</caption>
					<thead>
						<tr>
							<th scope="col">Method Attributes</th>
							<th scope="col">Method Name and Description</th>
						</tr>
					</thead>
					<tbody>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/api.File.html#ack">ack</a></b>(deliveryTag, multiple)
								</div>
								<div class="description">Acknowledge one or more messages.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/api.File.html#cancel">cancel</a></b>(consumerTag, nowait)
								</div>
								<div class="description">End a queue consumer.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/api.File.html#consume">consume</a></b>(ticket, queue, consumerTag, noLocal, noAck, exclusive, nowait)
								</div>
								<div class="description">Start a queue consumer.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/api.File.html#open">open</a></b>(identifier, contentSize)
								</div>
								<div class="description">Request to start staging.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/api.File.html#openOk">openOk</a></b>(stagedSize)
								</div>
								<div class="description">Confirm staging ready.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/api.File.html#publish">publish</a></b>(ticket, exchange, routingKey, mandatory, immediate, identifier)
								</div>
								<div class="description">Publish a message.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/api.File.html#qos">qos</a></b>(prefetchSize, prefetchCount, global)
								</div>
								<div class="description">Specify quality of service.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/api.File.html#reject">reject</a></b>(deliveryTag, requeue)
								</div>
								<div class="description">Reject an incoming message.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/api.File.html#stage">stage</a></b>()
								</div>
								<div class="description">Stage message content.</div>
							</td>
						</tr>
					
					</tbody>
				</table>
				
				
				
			
<!-- ============================== events summary ======================== -->
			
				
				
				<table class="summaryTable" cellspacing="0" summary="A summary of the events documented in the class api.File.">
					<caption>Event Summary</caption>
					<thead>
						<tr>
							<th scope="col">Event Attributes</th>
							<th scope="col">Event Name and Description</th>
						</tr>
					</thead>
					<tbody>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/api.File.html#event:cancelOk">cancelOk</a></b>(consumerTag)
								</div>
								<div class="description">Confirm a cancelled consumer.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/api.File.html#event:consumeOk">consumeOk</a></b>(consumerTag)
								</div>
								<div class="description">Confirm a new consumer.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/api.File.html#event:deliver">deliver</a></b>(consumerTag, deliveryTag, redelivered, exchange, routingKey, identifier)
								</div>
								<div class="description">Notify the client of a consumer message.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/api.File.html#event:open">open</a></b>(identifier, contentSize)
								</div>
								<div class="description">Request to start staging.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/api.File.html#event:openOk">openOk</a></b>(stagedSize)
								</div>
								<div class="description">Confirm staging ready.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/api.File.html#event:qosOk">qosOk</a></b>()
								</div>
								<div class="description">Confirm the requested qos.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/api.File.html#event:return">return</a></b>(replyCode, replyText, exchange, routingKey)
								</div>
								<div class="description">Return a failed message.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/api.File.html#event:stage">stage</a></b>()
								</div>
								<div class="description">Stage message content.</div>
							</td>
						</tr>
					
					</tbody>
				</table>
				
				
				
			

<!-- ============================== constructor details ==================== -->		
			
			<div class="details"><a name="constructor"> </a>
				<div class="sectionTitle">
					Class Detail
				</div>
				
				<div class="fixedFont">
						<b>api.File</b>()
				</div>
				
				<div class="description">
					Work with file content.

The file class provides methods that support reliable file transfer.
  File messages have a specific set of properties that are required for
  interoperability with file transfer applications. File messages and
  acknowledgements are subject to channel transactions.  Note that the
  file class does not provide message browsing methods; these are not
  compatible with the staging model.  Applications that need browsable
  file transfer should use Basic content and the Basic class.
					
				</div>
				
				
				
				
					
					
					
					
					
					
					

			</div>
			

<!-- ============================== field details ========================== -->		
			
				<div class="sectionTitle">
					Field Detail
				</div>
				
					<a name="clusterId"> </a>
					<div class="fixedFont">
					
					<span class="light">{String}</span>
					<b>clusterId</b>
					
					</div>
					<div class="description">
						Intra-cluster routing identifier
						
						
					</div>
					
					

						
						
						
						

					<hr />
				
					<a name="contentEncoding"> </a>
					<div class="fixedFont">
					
					<span class="light">{String}</span>
					<b>contentEncoding</b>
					
					</div>
					<div class="description">
						MIME content encoding
						
						
					</div>
					
					

						
						
						
						

					<hr />
				
					<a name="contentType"> </a>
					<div class="fixedFont">
					
					<span class="light">{String}</span>
					<b>contentType</b>
					
					</div>
					<div class="description">
						MIME content type
						
						
					</div>
					
					

						
						
						
						

					<hr />
				
					<a name="filename"> </a>
					<div class="fixedFont">
					
					<span class="light">{String}</span>
					<b>filename</b>
					
					</div>
					<div class="description">
						The message filename
						
						
					</div>
					
					

						
						
						
						

					<hr />
				
					<a name="headers"> </a>
					<div class="fixedFont">
					
					<span class="light">{Object}</span>
					<b>headers</b>
					
					</div>
					<div class="description">
						Message header field table
						
						
					</div>
					
					

						
						
						
						

					<hr />
				
					<a name="messageId"> </a>
					<div class="fixedFont">
					
					<span class="light">{String}</span>
					<b>messageId</b>
					
					</div>
					<div class="description">
						The application message identifier
						
						
					</div>
					
					

						
						
						
						

					<hr />
				
					<a name="priority"> </a>
					<div class="fixedFont">
					
					<span class="light">{Number}</span>
					<b>priority</b>
					
					</div>
					<div class="description">
						The message priority, 0 to 9
						
						
					</div>
					
					

						
						
						
						

					<hr />
				
					<a name="replyTo"> </a>
					<div class="fixedFont">
					
					<span class="light">{String}</span>
					<b>replyTo</b>
					
					</div>
					<div class="description">
						The destination to reply to
						
						
					</div>
					
					

						
						
						
						

					<hr />
				
					<a name="timestamp"> </a>
					<div class="fixedFont">
					
					<span class="light">{Date}</span>
					<b>timestamp</b>
					
					</div>
					<div class="description">
						The message timestamp
						
						
					</div>
					
					

						
						
						
						

					
				
			

<!-- ============================== method details ========================= -->		
			
				<div class="sectionTitle">
					Method Detail
				</div>
				
					<a name="ack"> </a>
					<div class="fixedFont">
					
					
					<b>ack</b>(deliveryTag, multiple)
					
					</div>
					<div class="description">
						Acknowledge one or more messages.

This method acknowledges one or more messages delivered via the
    Deliver method.  The client can ask to confirm a single message or
    a set of messages up to and including a specific message.
						
						
					</div>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{Number}</span> <b>deliveryTag</b>
									
								</dt>
								<dd>The server-assigned and channel-specific delivery tag</dd>
							
								<dt>
									<span class="light fixedFont">{Boolean}</span> <b>multiple</b>
									
								</dt>
								<dd>If set to 1, the delivery tag is treated as "up to and including",
      so that the client can acknowledge multiple messages with a single
      method.  If set to zero, the delivery tag refers to a single
      message.  If the multiple field is 1, and the delivery tag is zero,
      tells the server to acknowledge all outstanding mesages.</dd>
							
							</dl>
						
						
						
						
						
						
						

					<hr />
				
					<a name="cancel"> </a>
					<div class="fixedFont">
					
					
					<b>cancel</b>(consumerTag, nowait)
					
					</div>
					<div class="description">
						End a queue consumer.

This method cancels a consumer. This does not affect already
    delivered messages, but it does mean the server will not send any
    more messages for that consumer.
						
						
					</div>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{String}</span> <b>consumerTag</b>
									
								</dt>
								<dd>Identifier for the consumer, valid within the current connection.</dd>
							
								<dt>
									<span class="light fixedFont">{Boolean}</span> <b>nowait</b>
									
								</dt>
								<dd>If set, the server will not respond to the method. The client should
    not wait for a reply method.  If the server could not complete the
    method it will raise a channel or connection exception.</dd>
							
							</dl>
						
						
						
						
						
						
						

					<hr />
				
					<a name="consume"> </a>
					<div class="fixedFont">
					
					
					<b>consume</b>(ticket, queue, consumerTag, noLocal, noAck, exclusive, nowait)
					
					</div>
					<div class="description">
						Start a queue consumer.

This method asks the server to start a "consumer", which is a
    transient request for messages from a specific queue. Consumers
    last as long as the channel they were created on, or until the
    client cancels them.
						
						
					</div>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{Number}</span> <b>ticket</b>
									
								</dt>
								<dd>An access ticket granted by the server for a certain set of access
    rights within a specific realm. Access tickets are valid within the
    channel where they were created, and expire when the channel closes.</dd>
							
								<dt>
									<span class="light fixedFont">{String}</span> <b>queue</b>
									
								</dt>
								<dd>The queue name identifies the queue within the vhost.  Queue
    names may consist of any mixture of digits, letters, and
    underscores.</dd>
							
								<dt>
									<span class="light fixedFont">{String}</span> <b>consumerTag</b>
									
								</dt>
								<dd>Identifier for the consumer, valid within the current connection.</dd>
							
								<dt>
									<span class="light fixedFont">{Boolean}</span> <b>noLocal</b>
									
								</dt>
								<dd>If the no-local field is set the server will not send messages to
    the client that published them.</dd>
							
								<dt>
									<span class="light fixedFont">{Boolean}</span> <b>noAck</b>
									
								</dt>
								<dd>If this field is set the server does not expect acknowledgments
      for messages.  That is, when a message is delivered to the client
      the server automatically and silently acknowledges it on behalf
      of the client.  This functionality increases performance but at
      the cost of reliability.  Messages can get lost if a client dies
      before it can deliver them to the application.</dd>
							
								<dt>
									<span class="light fixedFont">{Boolean}</span> <b>exclusive</b>
									
								</dt>
								<dd>Request exclusive consumer access, meaning only this consumer can
      access the queue.</dd>
							
								<dt>
									<span class="light fixedFont">{Boolean}</span> <b>nowait</b>
									
								</dt>
								<dd>If set, the server will not respond to the method. The client should
    not wait for a reply method.  If the server could not complete the
    method it will raise a channel or connection exception.</dd>
							
							</dl>
						
						
						
						
						
						
						

					<hr />
				
					<a name="open"> </a>
					<div class="fixedFont">
					
					
					<b>open</b>(identifier, contentSize)
					
					</div>
					<div class="description">
						Request to start staging.

This method requests permission to start staging a message.  Staging
    means sending the message into a temporary area at the recipient end
    and then delivering the message by referring to this temporary area.
    Staging is how the protocol handles partial file transfers - if a
    message is partially staged and the connection breaks, the next time
    the sender starts to stage it, it can restart from where it left off.
						
						
					</div>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{String}</span> <b>identifier</b>
									
								</dt>
								<dd>This is the staging identifier. This is an arbitrary string chosen
      by the sender.  For staging to work correctly the sender must use
      the same staging identifier when staging the same message a second
      time after recovery from a failure.  A good choice for the staging
      identifier would be the SHA1 hash of the message properties data
      (including the original filename, revised time, etc.).</dd>
							
								<dt>
									<span class="light fixedFont">{Number}</span> <b>contentSize</b>
									
								</dt>
								<dd>The size of the content in octets.  The recipient may use this
      information to allocate or check available space in advance, to
      avoid "disk full" errors during staging of very large messages.</dd>
							
							</dl>
						
						
						
						
						
						
						

					<hr />
				
					<a name="openOk"> </a>
					<div class="fixedFont">
					
					
					<b>openOk</b>(stagedSize)
					
					</div>
					<div class="description">
						Confirm staging ready.

This method confirms that the recipient is ready to accept staged
    data.  If the message was already partially-staged at a previous
    time the recipient will report the number of octets already staged.
						
						
					</div>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{Number}</span> <b>stagedSize</b>
									
								</dt>
								<dd>The amount of previously-staged content in octets.  For a new
      message this will be zero.</dd>
							
							</dl>
						
						
						
						
						
						
						

					<hr />
				
					<a name="publish"> </a>
					<div class="fixedFont">
					
					
					<b>publish</b>(ticket, exchange, routingKey, mandatory, immediate, identifier)
					
					</div>
					<div class="description">
						Publish a message.

This method publishes a staged file message to a specific exchange.
    The file message will be routed to queues as defined by the exchange
    configuration and distributed to any active consumers when the
    transaction, if any, is committed.
						
						
					</div>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{Number}</span> <b>ticket</b>
									
								</dt>
								<dd>An access ticket granted by the server for a certain set of access
    rights within a specific realm. Access tickets are valid within the
    channel where they were created, and expire when the channel closes.</dd>
							
								<dt>
									<span class="light fixedFont">{String}</span> <b>exchange</b>
									
								</dt>
								<dd>The exchange name is a client-selected string that identifies
      the exchange for publish methods.  Exchange names may consist
      of any mixture of digits, letters, and underscores.  Exchange
      names are scoped by the virtual host.</dd>
							
								<dt>
									<span class="light fixedFont">{String}</span> <b>routingKey</b>
									
								</dt>
								<dd>Specifies the routing key for the message.  The routing key is
      used for routing messages depending on the exchange configuration.</dd>
							
								<dt>
									<span class="light fixedFont">{Boolean}</span> <b>mandatory</b>
									
								</dt>
								<dd>This flag tells the server how to react if the message cannot be
      routed to a queue.  If this flag is set, the server will return an
      unroutable message with a Return method.  If this flag is zero, the
      server silently drops the message.</dd>
							
								<dt>
									<span class="light fixedFont">{Boolean}</span> <b>immediate</b>
									
								</dt>
								<dd>This flag tells the server how to react if the message cannot be
      routed to a queue consumer immediately.  If this flag is set, the
      server will return an undeliverable message with a Return method.
      If this flag is zero, the server will queue the message, but with
      no guarantee that it will ever be consumed.</dd>
							
								<dt>
									<span class="light fixedFont">{String}</span> <b>identifier</b>
									
								</dt>
								<dd>This is the staging identifier of the message to publish.  The
      message must have been staged.  Note that a client can send the
      Publish method asynchronously without waiting for staging to
      finish.</dd>
							
							</dl>
						
						
						
						
						
						
						

					<hr />
				
					<a name="qos"> </a>
					<div class="fixedFont">
					
					
					<b>qos</b>(prefetchSize, prefetchCount, global)
					
					</div>
					<div class="description">
						Specify quality of service.

This method requests a specific quality of service.  The QoS can
    be specified for the current channel or for all channels on the
    connection.  The particular properties and semantics of a qos method
    always depend on the content class semantics.  Though the qos method
    could in principle apply to both peers, it is currently meaningful
    only for the server.
						
						
					</div>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{Number}</span> <b>prefetchSize</b>
									
								</dt>
								<dd>The client can request that messages be sent in advance so that
      when the client finishes processing a message, the following
      message is already held locally, rather than needing to be sent
      down the channel.  Prefetching gives a performance improvement.
      This field specifies the prefetch window size in octets. May be
      set to zero, meaning "no specific limit".  Note that other
      prefetch limits may still apply. The prefetch-size is ignored
      if the no-ack option is set.</dd>
							
								<dt>
									<span class="light fixedFont">{Number}</span> <b>prefetchCount</b>
									
								</dt>
								<dd>Specifies a prefetch window in terms of whole messages.  This
      is compatible with some file API implementations.  This field
      may be used in combination with the prefetch-size field; a
      message will only be sent in advance if both prefetch windows
      (and those at the channel and connection level) allow it.
      The prefetch-count is ignored if the no-ack option is set.</dd>
							
								<dt>
									<span class="light fixedFont">{Boolean}</span> <b>global</b>
									
								</dt>
								<dd>By default the QoS settings apply to the current channel only.  If
      this field is set, they are applied to the entire connection.</dd>
							
							</dl>
						
						
						
						
						
						
						

					<hr />
				
					<a name="reject"> </a>
					<div class="fixedFont">
					
					
					<b>reject</b>(deliveryTag, requeue)
					
					</div>
					<div class="description">
						Reject an incoming message.

This method allows a client to reject a message.  It can be used to
    return untreatable messages to their original queue.  Note that file
    content is staged before delivery, so the client will not use this
    method to interrupt delivery of a large message.
						
						
					</div>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{Number}</span> <b>deliveryTag</b>
									
								</dt>
								<dd>The server-assigned and channel-specific delivery tag</dd>
							
								<dt>
									<span class="light fixedFont">{Boolean}</span> <b>requeue</b>
									
								</dt>
								<dd>If this field is zero, the message will be discarded.  If this bit
      is 1, the server will attempt to requeue the message.</dd>
							
							</dl>
						
						
						
						
						
						
						

					<hr />
				
					<a name="stage"> </a>
					<div class="fixedFont">
					
					
					<b>stage</b>()
					
					</div>
					<div class="description">
						Stage message content.

This method stages the message, sending the message content to the
    recipient from the octet offset specified in the Open-Ok method.
						
						
					</div>
					
					
					
						
						
						
						
						
						
						

					
				
			
			
<!-- ============================== event details ========================= -->		
			
				<div class="sectionTitle">
					Event Detail
				</div>
				
					<a name="event:cancelOk"> </a>
					<div class="fixedFont">
					
					
					<b>cancelOk</b>(consumerTag)
					
					</div>
					<div class="description">
						Confirm a cancelled consumer.

This method confirms that the cancellation was completed.
						
						
					</div>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{String}</span> <b>consumerTag</b>
									
								</dt>
								<dd>Identifier for the consumer, valid within the current connection.</dd>
							
							</dl>
						
						
						
						
						
						
						

					<hr />
				
					<a name="event:consumeOk"> </a>
					<div class="fixedFont">
					
					
					<b>consumeOk</b>(consumerTag)
					
					</div>
					<div class="description">
						Confirm a new consumer.

This method provides the client with a consumer tag which it MUST
    use in methods that work with the consumer.
						
						
					</div>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{String}</span> <b>consumerTag</b>
									
								</dt>
								<dd>Identifier for the consumer, valid within the current connection.</dd>
							
							</dl>
						
						
						
						
						
						
						

					<hr />
				
					<a name="event:deliver"> </a>
					<div class="fixedFont">
					
					
					<b>deliver</b>(consumerTag, deliveryTag, redelivered, exchange, routingKey, identifier)
					
					</div>
					<div class="description">
						Notify the client of a consumer message.

This method delivers a staged file message to the client, via a
    consumer. In the asynchronous message delivery model, the client
    starts a consumer using the Consume method, then the server
    responds with Deliver methods as and when messages arrive for
    that consumer.
						
						
					</div>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{String}</span> <b>consumerTag</b>
									
								</dt>
								<dd>Identifier for the consumer, valid within the current connection.</dd>
							
								<dt>
									<span class="light fixedFont">{Number}</span> <b>deliveryTag</b>
									
								</dt>
								<dd>The server-assigned and channel-specific delivery tag</dd>
							
								<dt>
									<span class="light fixedFont">{Boolean}</span> <b>redelivered</b>
									
								</dt>
								<dd>This indicates that the message has been previously delivered to
      this or another client.</dd>
							
								<dt>
									<span class="light fixedFont">{String}</span> <b>exchange</b>
									
								</dt>
								<dd>The exchange name is a client-selected string that identifies
      the exchange for publish methods.  Exchange names may consist
      of any mixture of digits, letters, and underscores.  Exchange
      names are scoped by the virtual host.</dd>
							
								<dt>
									<span class="light fixedFont">{String}</span> <b>routingKey</b>
									
								</dt>
								<dd>Specifies the routing key name specified when the message was
      published.</dd>
							
								<dt>
									<span class="light fixedFont">{String}</span> <b>identifier</b>
									
								</dt>
								<dd>This is the staging identifier of the message to deliver.  The
      message must have been staged.  Note that a server can send the
      Deliver method asynchronously without waiting for staging to
      finish.</dd>
							
							</dl>
						
						
						
						
						
						
						

					<hr />
				
					<a name="event:open"> </a>
					<div class="fixedFont">
					
					
					<b>open</b>(identifier, contentSize)
					
					</div>
					<div class="description">
						Request to start staging.

This method requests permission to start staging a message.  Staging
    means sending the message into a temporary area at the recipient end
    and then delivering the message by referring to this temporary area.
    Staging is how the protocol handles partial file transfers - if a
    message is partially staged and the connection breaks, the next time
    the sender starts to stage it, it can restart from where it left off.
						
						
					</div>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{String}</span> <b>identifier</b>
									
								</dt>
								<dd>This is the staging identifier. This is an arbitrary string chosen
      by the sender.  For staging to work correctly the sender must use
      the same staging identifier when staging the same message a second
      time after recovery from a failure.  A good choice for the staging
      identifier would be the SHA1 hash of the message properties data
      (including the original filename, revised time, etc.).</dd>
							
								<dt>
									<span class="light fixedFont">{Number}</span> <b>contentSize</b>
									
								</dt>
								<dd>The size of the content in octets.  The recipient may use this
      information to allocate or check available space in advance, to
      avoid "disk full" errors during staging of very large messages.</dd>
							
							</dl>
						
						
						
						
						
						
						

					<hr />
				
					<a name="event:openOk"> </a>
					<div class="fixedFont">
					
					
					<b>openOk</b>(stagedSize)
					
					</div>
					<div class="description">
						Confirm staging ready.

This method confirms that the recipient is ready to accept staged
    data.  If the message was already partially-staged at a previous
    time the recipient will report the number of octets already staged.
						
						
					</div>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{Number}</span> <b>stagedSize</b>
									
								</dt>
								<dd>The amount of previously-staged content in octets.  For a new
      message this will be zero.</dd>
							
							</dl>
						
						
						
						
						
						
						

					<hr />
				
					<a name="event:qosOk"> </a>
					<div class="fixedFont">
					
					
					<b>qosOk</b>()
					
					</div>
					<div class="description">
						Confirm the requested qos.

This method tells the client that the requested QoS levels could
    be handled by the server.  The requested QoS applies to all active
    consumers until a new QoS is defined.
						
						
					</div>
					
					
					
						
						
						
						
						
						
						

					<hr />
				
					<a name="event:return"> </a>
					<div class="fixedFont">
					
					
					<b>return</b>(replyCode, replyText, exchange, routingKey)
					
					</div>
					<div class="description">
						Return a failed message.

This method returns an undeliverable message that was published
    with the "immediate" flag set, or an unroutable message published
    with the "mandatory" flag set. The reply code and text provide
    information about the reason that the message was undeliverable.
						
						
					</div>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{Number}</span> <b>replyCode</b>
									
								</dt>
								<dd>The reply code. The AMQ reply codes are defined in AMQ RFC 011.</dd>
							
								<dt>
									<span class="light fixedFont">{String}</span> <b>replyText</b>
									
								</dt>
								<dd>The localised reply text.  This text can be logged as an aid to
  resolving issues.</dd>
							
								<dt>
									<span class="light fixedFont">{String}</span> <b>exchange</b>
									
								</dt>
								<dd>The exchange name is a client-selected string that identifies
      the exchange for publish methods.  Exchange names may consist
      of any mixture of digits, letters, and underscores.  Exchange
      names are scoped by the virtual host.</dd>
							
								<dt>
									<span class="light fixedFont">{String}</span> <b>routingKey</b>
									
								</dt>
								<dd>Specifies the routing key name specified when the message was
      published.</dd>
							
							</dl>
						
						
						
						
						
						
						

					<hr />
				
					<a name="event:stage"> </a>
					<div class="fixedFont">
					
					
					<b>stage</b>()
					
					</div>
					<div class="description">
						Stage message content.

This method stages the message, sending the message content to the
    recipient from the octet offset specified in the Open-Ok method.
						
						
					</div>
					
					
					
						
						
						
						
						
						
						

					
				
			
			
			<hr />
		</div>

		
<!-- ============================== footer ================================= -->
		<div class="fineprint" style="clear:both">
			
			Documentation generated by <a href="http://code.google.com/p/jsdoc-toolkit/" target="_blank">JsDoc Toolkit</a> 2.4.0 on Thu Nov 04 2010 22:16:21 GMT+0200 (EET)
		</div>
	</body>
</html>
